home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / strevc.z / strevc
Text File  |  1996-03-14  |  7KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))                                                          SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      STREVC - compute some or all of the right and/or left eigenvectors of a
  10.      real upper quasi-triangular matrix T
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE STREVC( SIDE, HOWMNY, SELECT, N, T, LDT, VL, LDVL, VR, LDVR,
  14.                         MM, M, WORK, INFO )
  15.  
  16.          CHARACTER      HOWMNY, SIDE
  17.  
  18.          INTEGER        INFO, LDT, LDVL, LDVR, M, MM, N
  19.  
  20.          LOGICAL        SELECT( * )
  21.  
  22.          REAL           T( LDT, * ), VL( LDVL, * ), VR( LDVR, * ), WORK( * )
  23.  
  24. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  25.      STREVC computes some or all of the right and/or left eigenvectors of a
  26.      real upper quasi-triangular matrix T.
  27.  
  28.      The right eigenvector x and the left eigenvector y of T corresponding to
  29.      an eigenvalue w are defined by:
  30.  
  31.                   T*x = w*x,     y'*T = w*y'
  32.  
  33.      where y' denotes the conjugate transpose of the vector y.
  34.  
  35.      If all eigenvectors are requested, the routine may either return the
  36.      matrices X and/or Y of right or left eigenvectors of T, or the products
  37.      Q*X and/or Q*Y, where Q is an input orthogonal
  38.      matrix. If T was obtained from the real-Schur factorization of an
  39.      original matrix A = Q*T*Q', then Q*X and Q*Y are the matrices of right or
  40.      left eigenvectors of A.
  41.  
  42.      T must be in Schur canonical form (as returned by SHSEQR), that is, block
  43.      upper triangular with 1-by-1 and 2-by-2 diagonal blocks; each 2-by-2
  44.      diagonal block has its diagonal elements equal and its off-diagonal
  45.      elements of opposite sign.  Corresponding to each 2-by-2 diagonal block
  46.      is a complex conjugate pair of eigenvalues and eigenvectors; only one
  47.      eigenvector of the pair is computed, namely the one corresponding to the
  48.      eigenvalue with positive imaginary part.
  49.  
  50.  
  51.  
  52. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  53.      SIDE    (input) CHARACTER*1
  54.              = 'R':  compute right eigenvectors only;
  55.              = 'L':  compute left eigenvectors only;
  56.              = 'B':  compute both right and left eigenvectors.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))                                                          SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      HOWMNY  (input) CHARACTER*1
  75.              = 'A':  compute all right and/or left eigenvectors;
  76.              = 'B':  compute all right and/or left eigenvectors, and
  77.              backtransform them using the input matrices supplied in VR and/or
  78.              VL; = 'S':  compute selected right and/or left eigenvectors,
  79.              specified by the logical array SELECT.
  80.  
  81.      SELECT  (input/output) LOGICAL array, dimension (N)
  82.              If HOWMNY = 'S', SELECT specifies the eigenvectors to be
  83.              computed.  If HOWMNY = 'A' or 'B', SELECT is not referenced.  To
  84.              select the real eigenvector corresponding to a real eigenvalue
  85.              w(j), SELECT(j) must be set to .TRUE..  To select the complex
  86.              eigenvector corresponding to a complex conjugate pair w(j) and
  87.              w(j+1), either SELECT(j) or SELECT(j+1) must be set to .TRUE.;
  88.              then on exit SELECT(j) is .TRUE. and SELECT(j+1) is .FALSE..
  89.  
  90.      N       (input) INTEGER
  91.              The order of the matrix T. N >= 0.
  92.  
  93.      T       (input) REAL array, dimension (LDT,N)
  94.              The upper quasi-triangular matrix T in Schur canonical form.
  95.  
  96.      LDT     (input) INTEGER
  97.              The leading dimension of the array T. LDT >= max(1,N).
  98.  
  99.      VL      (input/output) REAL array, dimension (LDVL,MM)
  100.              On entry, if SIDE = 'L' or 'B' and HOWMNY = 'B', VL must contain
  101.              an N-by-N matrix Q (usually the orthogonal matrix Q of Schur
  102.              vectors returned by SHSEQR).  On exit, if SIDE = 'L' or 'B', VL
  103.              contains:  if HOWMNY = 'A', the matrix Y of left eigenvectors of
  104.              T; if HOWMNY = 'B', the matrix Q*Y; if HOWMNY = 'S', the left
  105.              eigenvectors of T specified by SELECT, stored consecutively in
  106.              the columns of VL, in the same order as their eigenvalues.  A
  107.              complex eigenvector corresponding to a complex eigenvalue is
  108.              stored in two consecutive columns, the first holding the real
  109.              part, and the second the imaginary part.  If SIDE = 'R', VL is
  110.              not referenced.
  111.  
  112.      LDVL    (input) INTEGER
  113.              The leading dimension of the array VL.  LDVL >= max(1,N) if SIDE
  114.              = 'L' or 'B'; LDVL >= 1 otherwise.
  115.  
  116.      VR      (input/output) REAL array, dimension (LDVR,MM)
  117.              On entry, if SIDE = 'R' or 'B' and HOWMNY = 'B', VR must contain
  118.              an N-by-N matrix Q (usually the orthogonal matrix Q of Schur
  119.              vectors returned by SHSEQR).  On exit, if SIDE = 'R' or 'B', VR
  120.              contains:  if HOWMNY = 'A', the matrix X of right eigenvectors of
  121.              T; if HOWMNY = 'B', the matrix Q*X; if HOWMNY = 'S', the right
  122.              eigenvectors of T specified by SELECT, stored consecutively in
  123.              the columns of VR, in the same order as their eigenvalues.  A
  124.              complex eigenvector corresponding to a complex eigenvalue is
  125.              stored in two consecutive columns, the first holding the real
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))                                                          SSSSTTTTRRRREEEEVVVVCCCC((((3333FFFF))))
  137.  
  138.  
  139.  
  140.              part and the second the imaginary part.  If SIDE = 'L', VR is not
  141.              referenced.
  142.  
  143.      LDVR    (input) INTEGER
  144.              The leading dimension of the array VR.  LDVR >= max(1,N) if SIDE
  145.              = 'R' or 'B'; LDVR >= 1 otherwise.
  146.  
  147.      MM      (input) INTEGER
  148.              The number of columns in the arrays VL and/or VR. MM >= M.
  149.  
  150.      M       (output) INTEGER
  151.              The number of columns in the arrays VL and/or VR actually used to
  152.              store the eigenvectors.  If HOWMNY = 'A' or 'B', M is set to N.
  153.              Each selected real eigenvector occupies one column and each
  154.              selected complex eigenvector occupies two columns.
  155.  
  156.      WORK    (workspace) REAL array, dimension (3*N)
  157.  
  158.      INFO    (output) INTEGER
  159.              = 0:  successful exit
  160.              < 0:  if INFO = -i, the i-th argument had an illegal value
  161.  
  162. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  163.      The algorithm used in this program is basically backward (forward)
  164.      substitution, with scaling to make the the code robust against possible
  165.      overflow.
  166.  
  167.      Each eigenvector is normalized so that the element of largest magnitude
  168.      has magnitude 1; here the magnitude of a complex number (x,y) is taken to
  169.      be |x| + |y|.
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.